fix: Update task title without opening the report #32249

paultsimura · 2023-11-30T10:17:15Z

Details

In this PR, 2 issues are fixed:

When a user receives a task, the "Copy to clipboard" action copies the task title correctly without the need to open the task thread.
The "created task" message in LHN gets updated when the task title is modified

Fixed Issues

$ #29035
PROPOSAL: #29035 (comment)

Tests

Same as QA

Offline tests

The user must be online to receive new tasks and task title updates.

QA Steps

Log in as User A
Share a task with User B
Open another browser and log in as User B
Open the chat with User A chat and click on “Copy to clipboard” of the sent task, but don't open the task itself
Paste the copied text in the chat.

Verify that the text contains "task for ${title}" with the correct task title
Verify that the chat with User A has the "task for ${title}" with the correct task title in LHN

As User A, modify the Task title
As User B, click on “Copy to clipboard” of the task, and paste it in the chat.

Verify that the text contains "task for ${title}" with the updated task title
Verify that the chat with User A has the "task for ${title}" with the updated task title in LHN

Change language to Spanish

Verify that both LHN text and the one copied to the clipboard are translated into Spanish.

PR Author Checklist

Screenshots/Videos

Android: Native

android-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

ios-compressed.mp4

iOS: mWeb Safari

safari-compressed.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2023-11-30T16:11:23Z

@cubuspl42 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

cubuspl42 · 2023-12-01T12:06:24Z

src/libs/TaskUtils.ts

+const allReports: Record<string, Report> = {};
+Onyx.connect({
+    key: ONYXKEYS.COLLECTION.REPORT,
+    callback: (report, key) => {
+        if (!key || !report) {
+            return;
+        }
+        const reportID = CollectionUtils.extractCollectionItemID(key);
+        allReports[reportID] = report;
+    },
+});


This basically line-to-line duplicate of this block, and maybe others.

Yup. I once had a somewhat similar question, and this was the response from @tgolen:

I haven’t seen duplicate connect()s be a problem yet, so that’s what I would do.

I may not be aware, is there a way to reuse the Onyx.connect?

I don't know, maybe ReportUtils.getReportById or something like that? It seems werid to just copy-paste this because there "hasn't been a problem yet"...

@tgolen what would you say? Can we reuse utils inside other utils instead of using Onyx.connect?

That is a very nuanced topic, so I apologize in advance for the long comment, but I want you to hear my thinking.

There is no technical problem with having the same connect() in two different libs. The only "problem" is that it is repetitive code, which is a somewhat valid argument. However, let's take that logic all the way to the grand conclusion. If we only intend to have one connect() for every key, then that basically results in some kind of file that contains all the connect() calls for every key. This then creates an odd in-memory type store of everything that Onyx already has in memory. This is just a strange place to end up in.

Having duplicate connect()s in the files that need them allows them to be custom-tailored for fast lookups or custom maps depending on what data is being accessed. For example, rather than doing a .filter() or .map() every time the data needs accessed, the connect() callback should store the data in an efficient way so that it can be easily and quickly accessed like reports[reportID] and there is no need to filter or map. This allows for code to be much more optimized, rather than kept in a very general and slow method (because it has to account for different libs wanting to access it in different ways).

Thanks, this makes sense in terms of productivity vs clean code.
Based on the comment above, should we be good to go with this approach @cubuspl42?

This doesn't make sense, at least to me.

The only "problem" is that it is repetitive code, which is a somewhat valid argument

Code duplication is an industry-standard problem with industry-standard solutions.

Even more precisely, even the duplication of data access code is industry-standard, this has been present since the old days of hand-crafted MPA DAOs written in PHP, Java, or whatever. The only twist is the data is reactive here, changing as the time flows.

We've discussed the "big picture", the general case, but coming down to our case, the only argument I can hear for not de-duplicating this is "this might be optimized in the future, so let's keep the duplication", which falls into the YAGNI category for me.

Having said all this, it's not a blocker for me, as I'm kind of busy and can't afford discussing this too much.

cubuspl42 · 2023-12-05T13:00:45Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

task-title-clipboard-web.mp4

Mobile Web - Chrome

task-title-clipboard-android-web-compressed.mp4

Mobile Web - Safari

task-title-clipboard-ios-web.mp4

Desktop

iOS

task-title-clipboard-ios.mp4

Android

task-title-clipboard-android-compressed.mp4

tgolen · 2023-12-08T15:25:59Z

@thienlnam Can you please get this reviewed soon?

thienlnam

Looks good, thanks!

OSBotify · 2023-12-08T19:01:54Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

tgolen · 2023-12-08T21:44:57Z

src/pages/home/report/ContextMenu/ContextMenuActions.js

            const isReportPreviewAction = ReportActionsUtils.isReportPreviewAction(reportAction);
            const message = _.last(lodashGet(reportAction, 'message', [{}]));
-            const reportID = lodashGet(reportAction, 'originalMessage.taskReportID', '').toString();
-            const messageHtml = isTaskAction || isCreateTaskAction ? Task.getTaskReportActionMessage(reportAction.actionName, reportID, isCreateTaskAction) : lodashGet(message, 'html', '');
+            const messageHtml = isTaskAction ? Task.getTaskReportActionMessage(reportAction) : lodashGet(message, 'html', '');


Hi, it looks like this method was moved to TaskUtils but this reference wasn't updated. It results in the following webpack warning on main and it will probably cause the app to crash:

[web-server] WARNING in ./src/pages/home/report/ContextMenu/ContextMenuActions.js 277:37-68 [web-server] export 'getTaskReportActionMessage' (imported as 'Task') was not found in '@userActions/Task' (possible exports: canModifyTask, cancelTask, clearOutTaskInfo, clearOutTaskInfoAndNavigate, clearTaskErrors, completeTask, createTaskAndNavigate, dismissModalAndClearOutTaskInfo, editTask, editTaskAssignee, getAssignee, getShareDestination, getTaskAssigneeAccountID, reopenTask, setAssigneeValue, setDescriptionValue, setDetailsValue, setShareDestinationValue, setTaskReport, setTitleValue) [web-server] @ ./src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js 24:0-78 39:8-40 65:44-62 [web-server] @ ./src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.js 11:0-72 311:38-65 [web-server] @ ./src/Expensify.js 43:0-108 209:39-69 [web-server] @ ./src/App.js 23:0-36 55:97-106 [web-server] @ ./index.js 6:0-28 11:9-12

thienlnam · 2023-12-08T21:50:37Z

@paultsimura Could you please spin up another GH to fix the webpack error?

paultsimura · 2023-12-08T21:53:50Z

@thienlnam sure, will do tomorrow

paultsimura · 2023-12-09T06:05:42Z

The fix PR is ready for review: #32774. It'd be best if we could get it reviewed and merged before this one is deployed to staging.
My apologies for missing it in the first place.

@thienlnam @cubuspl42

OSBotify · 2023-12-11T10:44:40Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.11-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

OSBotify · 2023-12-13T11:09:19Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.11-25 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

s77rt · 2024-02-13T20:44:21Z

src/libs/TaskUtils.ts

+function getTaskCreatedMessage(reportAction: OnyxEntry<ReportAction>) {
+    const taskReportID = reportAction?.childReportID ?? '';
+    const taskTitle = getTaskTitle(taskReportID, reportAction?.childReportName);
+    return Localize.translateLocal('task.messages.created', {title: taskTitle});
+}


If taskTitle is falsy we should have returned an empty string as it does not make sense to return task create message with no task title i.e. task for .

Returning empty string enables other other parts of the app to detect failure in getting task created message so we can fallback to other messages.

(Coming from #35002)

Fix task title calculation

63a5380

paultsimura force-pushed the fix/29035-task-title-clipboard branch from ac16d9e to 63a5380 Compare November 30, 2023 10:23

paultsimura marked this pull request as ready for review November 30, 2023 16:11

paultsimura requested a review from a team as a code owner November 30, 2023 16:11

melvin-bot bot requested review from cubuspl42 and removed request for a team November 30, 2023 16:11

paultsimura mentioned this pull request Nov 30, 2023

[HOLD for payment 2023-12-20] [$500] Task - When the receiver clicks on 'Copy to clipboard' for a task, the copied text shows incorrectly #29035

Closed

6 tasks

cubuspl42 reviewed Dec 1, 2023

View reviewed changes

cubuspl42 approved these changes Dec 5, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam December 5, 2023 13:02

thienlnam approved these changes Dec 8, 2023

View reviewed changes

thienlnam merged commit 138e6a2 into Expensify:main Dec 8, 2023
16 of 64 checks passed

tgolen reviewed Dec 8, 2023

View reviewed changes

paultsimura mentioned this pull request Dec 9, 2023

Fix: Use TaskUtils for copying the task report actions to clipboard #32774

Merged

48 tasks

github-actions bot mentioned this pull request Dec 11, 2023

Deploy Checklist: New Expensify 2023-12-11 #32794

Closed

81 tasks

This comment was marked as resolved.

Sign in to view

namhihi237 mentioned this pull request Dec 15, 2023

[$500] LHN - Task name not displayed in chat preview in LHN after re-logging #33165

Closed

6 tasks

s77rt reviewed Feb 13, 2024

View reviewed changes

s77rt mentioned this pull request Feb 13, 2024

[HOLD for payment 2024-02-20] [$500] LHN - Task name on secondary user LHN does not update until open the report #35002

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Update task title without opening the report #32249

fix: Update task title without opening the report #32249

paultsimura commented Nov 30, 2023 •

edited

Loading

melvin-bot bot commented Nov 30, 2023

cubuspl42 Dec 1, 2023

paultsimura Dec 1, 2023

cubuspl42 Dec 1, 2023

paultsimura Dec 1, 2023

tgolen Dec 1, 2023

paultsimura Dec 2, 2023

cubuspl42 Dec 4, 2023

cubuspl42 commented Dec 5, 2023

tgolen commented Dec 8, 2023

thienlnam left a comment

OSBotify commented Dec 8, 2023

tgolen Dec 8, 2023

thienlnam commented Dec 8, 2023

paultsimura commented Dec 8, 2023

paultsimura commented Dec 9, 2023 •

edited

Loading

OSBotify commented Dec 11, 2023

This comment was marked as resolved.

OSBotify commented Dec 13, 2023

s77rt Feb 13, 2024

fix: Update task title without opening the report #32249

fix: Update task title without opening the report #32249

Conversation

paultsimura commented Nov 30, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cubuspl42 commented Dec 5, 2023

Reviewer Checklist

Screenshots/Videos

tgolen commented Dec 8, 2023

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 8, 2023

Choose a reason for hiding this comment

thienlnam commented Dec 8, 2023

paultsimura commented Dec 8, 2023

paultsimura commented Dec 9, 2023 • edited Loading

OSBotify commented Dec 11, 2023

This comment was marked as resolved.

OSBotify commented Dec 13, 2023

Choose a reason for hiding this comment

paultsimura commented Nov 30, 2023 •

edited

Loading

paultsimura commented Dec 9, 2023 •

edited

Loading